SMTP Parameters

Client-wide variable that allows you to configure SMTP(S) to establish the email connection that the Automation Engine and/or the relevant Agents use to send (secure) emails. For more information, see Setting Up Email Connections.

Important! Make sure you consider the following issues before setting up these parameters:

  • When you use these parameters also to define the SMTP server used with the SEND_MAIL script function, be aware that changing keys, for example, the SMTP_PROTOCOL, affects both, the SEND_MAIL script function and the Notification (CALL) object, see SEND_MAIL and MAIL Notifications.

  • The SMTP_SERVER and SMTP_FROM_ADDR keys are always mandatory.

  • When you select the STARTTLS or TLS protocols, defining the SMTPS_CERT key is mandatory, too. Make sure that the relevant certificate is available in the UC_TRUSTEDCERTS Storage object in Client 0, see UC_TRUSTEDCERTS Storage Object.

  • Not all Agents support sending (secure) emails, see Setting Up Email Connections.

  • Agents that support SMTP but not SMTPS ignore the keys that are relevant for TLS. If they are able to send emails, they do so using the PLAIN protocol, the definition of the SMTP_SERVER key and the default SMTP_PORT definition (25), which secures backward compatibility with Agents that do not support sending secure emails.

  • If you want to define more than one SMTP server using different configurations, you must use the SEND_MAIL script function to send emails and define one UC_SMTP_MYSERVER variable for each server, see UC_SMTP_MYSERVER - SMTP Variable.

The following parameters are available:

SMTP_FROM_ADDR

  • Description: (Mandatory) Email address of the sender.

  • Restart required: No

SMTP_LOGIN

  • Description: (Optional) Name of the Login object that is used to log on to the SMTP server.

  • Restart required: No

SMTP_MAX_ATTACHMENT_SIZE

  • Description: (Optional) Maximum size in bytes of the report file that is sent by email. This applies only to reports that are sent by email, but not to other types of attachments.

    In the Notification page of a Notification object, specify the RunID of the relevant task so that the corresponding reports can be attached to the message. For more information, see Notification (CALL).

  • Allowed values: 400 - 50000

    When the report file exceeds the maximum value, only the allowed size is read and sent. The file end includes the following note: Truncated through SMTP_MAX_ATTACHMENT_SIZE limit.

  • Default value: 8000

  • Restart required: No

SMTP_PORT

  • Description: (Optional) Port of the SMTP(S) server used to connect to the mail server.

    A port that supports TLS might be required when STARTTLS or TLS are set as the SMTP_PROTOCOL.

  • Default value: 25

  • Restart required: No

SMTP_PROTOCOL

  • Description: (Optional) The protocol that you want to use to establish the communication.

  • Allowed values: upper case, lower case, and mixed case letters

    • PLAIN (default)

      Sends emails through an unencrypted connection.

    • STARTTLS

      Sends emails through an opportunistic TLS connection. Depending on how your SMTP server is configured, you might also need to change SMTP_PORT to change its default behavior.

    • TLS

      Sends emails through a forced TLS connection. In this case, you require a port that supports TLS.

    When you select STARTTLS or TLS, it is mandatory to define the SMTPS_CERT parameter and point to the certificate that you want to use. Make sure that the relevant certificate has been uploaded to the UC_TRUSTEDCERTS Storage object in Client 0, see UC_TRUSTEDCERTS Storage Object.

  • Restart required: No

SMTP_REPLY_TO

  • Description: (Optional) Email address for the response.

  • Restart required: No

SMTP_SERVER

  • Description: (Mandatory) Host name of the SMTP server.

  • Restart required: No

SMTP_TIMEOUT

  • Description: (Optional) Maximum time in seconds that the system waits for an SMTP Server to respond.

  • Allowed values: 0 - 999

  • Default value: 20

  • Restart required: No

SMTPS_CERT

  • Description: (Mandatory, when STARTTLS or TLS are set as the SMTP_PROTOCOL)

    Name of the certificate stored in the UC_TRUSTEDCERTS Storage object in Client 0, see UC_TRUSTEDCERTS Storage Object.

    When you use an Agent to send secure emails, the system searches in the UC_TRUSTEDCERTS Storage object for the certificate that has been defined in the SMTPS_CERT key. The AE sends that file to the Agent, which uses it to send an email to the SMTP server. However, the Agent caches the certificate and only gets a new one if changes are made in the UC_TRUSTEDCERTS Storage object (changes trigger cache clearing).

  • Restart required: No

See also: